package org.jsola.contract.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.contract.dto.SealPositionAddDTO;
import org.jsola.contract.dto.SealPositionBatchDTO;
import org.jsola.contract.dto.SealPositionUpdateDTO;
import org.jsola.contract.query.SealPositionQuery;
import org.jsola.contract.vo.SealPositionListVO;
import org.jsola.contract.vo.SealPositionVO;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.springframework.web.bind.annotation.RequestBody;

import javax.validation.Valid;
import java.util.List;

/**
 * 合同默认签章位置
 *
 * @author JanusMix
 */
@Api(tags = "contract-合同默认签章位置")
public interface ISealPositionControllerAPI {

    /**
     * 新增合同默认签章位置
     *
     * @param sealPositionAddDTO 合同默认签章位置新增实体
     * @return 合同默认签章位置展示对象
     */
    @ApiOperation(value = "新增合同默认签章位置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sealPositionAddDTO", dataType = "SealPositionAddDTO", value = "新增合同默认签章位置", paramType = "body")
    })
    Result<SealPositionVO> save(SealPositionAddDTO sealPositionAddDTO);

    /**
     * 新增/修改合同默认（删除原有 重新添加）
     *
     * @param sealPositionAddDTOList 新增合同默认签章位置DTO
     * @return 合同默认签章位置详情信息
     */
    @ApiOperation(value = "新增合同默认签章位置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sealPositionAddDTO", dataType = "SealPositionAddDTO", value = "新增合同默认签章位置", paramType = "body", required = true)
    })
    Result<List<SealPositionVO>> saveOrUpdate(List<SealPositionAddDTO> sealPositionAddDTOList);

    /**
     * 根据模板id  新增/修改合同默认签章位置（删除原有 重新添加）
     *
     * @param templateId 模板id
     * @param sealPositionAddDTOList 新增合同默认签章位置DTO
     * @return 合同默认签章位置详情信息
     */
    @ApiOperation(value = "新增合同默认签章位置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateId", dataType = "Long", value = "模板id", paramType = "path"),
            @ApiImplicitParam(name = "sealPositionAddDTO", dataType = "SealPositionAddDTO", value = "新增合同默认签章位置", paramType = "body", required = true)
    })
    Result<List<SealPositionVO>> saveOrUpdate(Long templateId, List<SealPositionAddDTO> sealPositionAddDTOList);



    /**
     * 修改合同默认签章位置
     *
     * @param sealPositionUpdateDTO 合同默认签章位置
     * @return 更新数量
     */
    @ApiOperation(value = "修改合同默认签章位置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sealPositionUpdateDTO", dataType = "SealPositionUpdateDTO", value = "修改合同默认签章位置", paramType = "body")
    })
    Result<Integer> update(SealPositionUpdateDTO sealPositionUpdateDTO);

    /**
     * 批量编辑、新增、删除合同默认签章位置
     *
     * @param sealPositionBatchDTO 要操作的合同默认签章位置
     * @return 操作之后的全部合同默认签章位置
     */
    @ApiOperation(value = "批量编辑、新增、删除合同默认签章位置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sealPositionBatchDTO", dataType = "SealPositionBatchDTO", value = "要操作的字段数据", paramType = "body")
    })
    Result batch(SealPositionBatchDTO sealPositionBatchDTO);


    /**
     * 删除单个合同默认签章位置，彻底删除
     *
     * @param sealPositionId 合同默认签章位置id
     * @return 删除数量
     */
    @ApiOperation(value = "删除单个合同默认签章位置，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sealPositionId", dataType = "Long", value = "合同默认签章位置id", paramType = "path")
    })
    Result<Integer> delete(Long sealPositionId);


    /**
     * 批量删除合同默认签章位置，彻底删除
     *
     * @param sealPositionIds 合同默认签章位置id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除合同默认签章位置，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sealPositionIds", dataType = "Long[]", value = "合同默认签章位置id数组", paramType = "body", allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] sealPositionIds);


    /**
     * 根据合同默认签章位置id查询合同默认签章位置详情
     *
     * @param sealPositionId 合同默认签章位置id
     * @return 合同默认签章位置详情
     */
    @ApiOperation(value = "根据合同默认签章位置id查询合同默认签章位置详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sealPositionId", dataType = "Long", value = "合同默认签章位置id", paramType = "path")
    })
    Result<SealPositionVO> findById(Long sealPositionId);


    /**
     * 查询合同默认签章位置
     *
     * @param sealPositionQuery 合同默认签章位置查询参数
     * @return page
     */
    @ApiOperation(value = "查询合同默认签章位置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sealPositionQuery", dataType = "SealPositionQuery", value = "合同默认签章位置查询参数", paramType = "query")
    })
    Result<List<SealPositionListVO>> listAll(SealPositionQuery sealPositionQuery);


    /**
     * 分页查询合同默认签章位置
     *
     * @param sealPositionQuery 合同默认签章位置查询参数
     * @return page
     */
    @ApiOperation(value = "分页查询合同默认签章位置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "sealPositionQuery", dataType = "SealPositionQuery", value = "合同默认签章位置查询参数", paramType = "query")
    })
    Result<Page<SealPositionListVO>> page(SealPositionQuery sealPositionQuery);


}

